<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>keyczar.keyczar.Crypter</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="keyczar-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >Keyczar</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="keyczar-module.html">Package&nbsp;keyczar</a> ::
        <a href="keyczar.keyczar-module.html">Module&nbsp;keyczar</a> ::
        Class&nbsp;Crypter
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="keyczar.keyczar.Crypter-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Crypter</h1><p class="nomargin-top"><span class="codelink"><a href="keyczar.keyczar-pysrc.html#Crypter">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+        
         |        
   <a href="keyczar.keyczar.Keyczar-class.html">Keyczar</a> --+    
             |    
     <a href="keyczar.keyczar.Encrypter-class.html">Encrypter</a> --+
                 |
                <strong class="uidshort">Crypter</strong>
</pre>

<hr />
<p>Capable of encrypting and decrypting.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="keyczar.keyczar.Crypter-class.html#IsAcceptablePurpose" class="summary-sig-name">IsAcceptablePurpose</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">purpose</span>)</span><br />
      Only valid if purpose includes decrypting</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="keyczar.keyczar-pysrc.html#Crypter.IsAcceptablePurpose">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">string</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="keyczar.keyczar.Crypter-class.html#Decrypt" class="summary-sig-name">Decrypt</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">ciphertext</span>)</span><br />
      Decrypts the given ciphertext and returns the plaintext.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="keyczar.keyczar-pysrc.html#Crypter.Decrypt">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="keyczar.keyczar.Encrypter-class.html">Encrypter</a></code></b>:
      <code><a href="keyczar.keyczar.Encrypter-class.html#Encrypt">Encrypt</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="keyczar.keyczar.Keyczar-class.html">Keyczar</a></code></b>:
      <code><a href="keyczar.keyczar.Keyczar-class.html#GetKey">GetKey</a></code>,
      <code><a href="keyczar.keyczar.Keyczar-class.html#__init__">__init__</a></code>,
      <code><a href="keyczar.keyczar.Keyczar-class.html#__str__">__str__</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="keyczar.keyczar.Keyczar-class.html">Keyczar</a></code></b> (private):
      <code><a href="keyczar.keyczar.Keyczar-class.html#_AddKey" onclick="show_private();">_AddKey</a></code>,
      <code><a href="keyczar.keyczar.Keyczar-class.html#_ParseHeader" onclick="show_private();">_ParseHeader</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Static Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-StaticMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="keyczar.keyczar.Crypter-class.html" class="link">Crypter</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="keyczar.keyczar.Crypter-class.html#Read" class="summary-sig-name">Read</a>(<span class="summary-sig-arg">location</span>)</span><br />
      Return a Crypter object created from FileReader at given location.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="keyczar.keyczar-pysrc.html#Crypter.Read">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="keyczar.keyczar.Keyczar-class.html">Keyczar</a></code></b>:
      <code><a href="keyczar.keyczar.Keyczar-class.html#primary_key">primary_key</a></code>,
      <code><a href="keyczar.keyczar.Keyczar-class.html#versions">versions</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="Read"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Read</span>(<span class="sig-arg">location</span>)</span>
    <br /><em class="fname">Static Method</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="keyczar.keyczar-pysrc.html#Crypter.Read">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Return a Crypter object created from FileReader at given location.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>location</code></strong> (string) - pathname of the directory storing the key files</li>
    </ul></dd>
    <dt>Returns: <a href="keyczar.keyczar.Crypter-class.html" class="link">Crypter</a></dt>
        <dd>a Crypter to manage the keys stored at the given location and 
          perform encryption and decryption functions.</dd>
    <dt>Overrides:
        <a href="keyczar.keyczar.Keyczar-class.html#Read">Keyczar.Read</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="IsAcceptablePurpose"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">IsAcceptablePurpose</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">purpose</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="keyczar.keyczar-pysrc.html#Crypter.IsAcceptablePurpose">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Only valid if purpose includes decrypting</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="keyczar.keyczar.Keyczar-class.html#IsAcceptablePurpose">Keyczar.IsAcceptablePurpose</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="Decrypt"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Decrypt</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">ciphertext</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="keyczar.keyczar-pysrc.html#Crypter.Decrypt">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Decrypts the given ciphertext and returns the plaintext.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ciphertext</code></strong> (string) - Base64 encoded string ciphertext to be decrypted.</li>
    </ul></dd>
    <dt>Returns: string</dt>
        <dd>plaintext message</dd>
    <dt>Raises:</dt>
    <dd><ul class="nomargin-top">
        <li><code><strong class='fraise'><a href="keyczar.errors.ShortCiphertextError-class.html">ShortCiphertextError</a></strong></code> - if length is too short to have Header, IV, Sig</li>
        <li><code><strong class='fraise'><a href="keyczar.errors.BadVersionError-class.html">BadVersionError</a></strong></code> - if header specifies an illegal version</li>
        <li><code><strong class='fraise'>BadFormatError</strong></code> - if header specifies an illegal format</li>
        <li><code><strong class='fraise'><a href="keyczar.errors.KeyNotFoundError-class.html">KeyNotFoundError</a></strong></code> - if key specified in header doesn't exist</li>
        <li><code><strong class='fraise'><a href="keyczar.errors.InvalidSignatureError-class.html">InvalidSignatureError</a></strong></code> - if the signature can't be verified</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="keyczar-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >Keyczar</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Aug 10 17:05:05 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
